Trait jumpy::prelude::bones_utils::prelude::alloc::fmt::Debug

1.0.0 · source ·

pub trait Debug {
    // Required method
    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>;
}

Expand description

? formatting.

Debug should format the output in a programmer-facing, debugging context.

Generally speaking, you should just derive a Debug implementation.

When used with the alternate format specifier #?, the output is pretty-printed.

For more information on formatters, see the module-level documentation.

This trait can be used with #[derive] if all fields implement Debug. When derived for structs, it will use the name of the struct, then {, then a comma-separated list of each field’s name and Debug value, then }. For enums, it will use the name of the variant and, if applicable, (, then the Debug values of the fields, then ).

Stability

Derived Debug formats are not stable, and so may change with future Rust versions. Additionally, Debug implementations of types provided by the standard library (std, core, alloc, etc.) are not stable, and may also change with future Rust versions.

Examples

Deriving an implementation:

#[derive(Debug)]
struct Point {
    x: i32,
    y: i32,
}

let origin = Point { x: 0, y: 0 };

assert_eq!(format!("The origin is: {origin:?}"), "The origin is: Point { x: 0, y: 0 }");

Manually implementing:

use std::fmt;

struct Point {
    x: i32,
    y: i32,
}

impl fmt::Debug for Point {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Point")
         .field("x", &self.x)
         .field("y", &self.y)
         .finish()
    }
}

let origin = Point { x: 0, y: 0 };

assert_eq!(format!("The origin is: {origin:?}"), "The origin is: Point { x: 0, y: 0 }");

There are a number of helper methods on the Formatter struct to help you with manual implementations, such as debug_struct.

Types that do not wish to use the standard suite of debug representations provided by the Formatter trait (debug_struct, debug_tuple, debug_list, debug_set, debug_map) can do something totally custom by manually writing an arbitrary representation to the Formatter.

impl fmt::Debug for Point {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Point [{} {}]", self.x, self.y)
    }
}

Debug implementations using either derive or the debug builder API on Formatter support pretty-printing using the alternate flag: {:#?}.

Pretty-printing with #?:

#[derive(Debug)]
struct Point {
    x: i32,
    y: i32,
}

let origin = Point { x: 0, y: 0 };

assert_eq!(format!("The origin is: {origin:#?}"),
"The origin is: Point {
    x: 0,
    y: 0,
}");

Required Methods§

source

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

Examples

use std::fmt;

struct Position {
    longitude: f32,
    latitude: f32,
}

impl fmt::Debug for Position {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_tuple("")
         .field(&self.longitude)
         .field(&self.latitude)
         .finish()
    }
}

let position = Position { longitude: 1.987, latitude: 2.983 };
assert_eq!(format!("{position:?}"), "(1.987, 2.983)");

assert_eq!(format!("{position:#?}"), "(
    1.987,
    2.983,
)");

source §

impl Debug for EndOfInput

source §

impl Debug for untrusted::reader::Reader<'_>

Avoids writing the value or position to avoid creating a side channel, though Reader can’t avoid leaking the position via timing.

§

impl Debug for Event

§

impl Debug for Event

When the alternate flag is enabled this will print platform specific details, for example the fields of the kevent structure on platforms that use kqueue(2). Note however that the output of this implementation is not consider a part of the stable API.

let rasterizer = ab_glyph_rasterizer::Rasterizer::new(3, 4);
assert_eq!(
    &format!("{:?}", rasterizer),
    "Rasterizer { width: 3, height: 4 }"
);

Styles have a special Debug implementation that only shows the fields that are set. Fields that haven’t been touched aren’t included in the output.

This behaviour gets bypassed when using the alternate formatting mode format!("{:#?}").

use nu_ansi_term::Color::{Red, Blue};
assert_eq!("Style { fg(Red), on(Blue), bold, italic }",
           format!("{:?}", Red.on(Blue).bold().italic()));

§

impl<T, O> Debug for BitVec<T, O>
where T: BitStore, O: BitOrder,

§

impl<T, O> Debug for Drain<'_, T, O>
where T: BitStore, O: BitOrder,

§

impl<T, O> Debug for IntoIter<T, O>
where T: BitStore, O: BitOrder,

Original

§

impl<T, O> Debug for Iter<'_, T, O>
where T: BitStore, O: BitOrder,

Original

§

impl<T, O> Debug for IterMut<'_, T, O>
where T: BitStore, O: BitOrder,

Trait jumpy::prelude::bones_utils::prelude::alloc::fmt::Debug

Stability

Examples

Required Methods§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Examples

Implementors§

impl Debug for AudioEvent

impl Debug for CrabState

impl Debug for FishState

impl Debug for MachineGunState

impl Debug for Snail

impl Debug for SwordState

impl Debug for EditorInput

impl Debug for PhysicsError

impl Debug for TileCollisionKind

impl Debug for ColliderShape

impl Debug for PhysicsStage

impl Debug for CoefficientCombineRule

impl Debug for ColliderEnabled

impl Debug for ColliderType

impl Debug for CollisionEvent

impl Debug for FeatureId

impl Debug for JointAxis

impl Debug for JointEnabled

impl Debug for MotorModel

impl Debug for RigidBodyAdditionalMassProps

impl Debug for RigidBodyType

impl Debug for SegmentPointLocation

impl Debug for ShapeType

impl Debug for TopologyError

impl Debug for TriangleOrientation

impl Debug for TrianglePointLocation

impl Debug for TAffine

impl Debug for TGeneral

impl Debug for TProjective

impl Debug for Emote

impl Debug for EaseFunction

impl Debug for MetaHandleCastError

impl Debug for ControlSource

impl Debug for InputKind

impl Debug for MapSelectAction

impl Debug for NetworkGameAction

impl Debug for PauseMenuPage

impl Debug for EcsRefBorrowError

impl Debug for EnumTagType

impl Debug for jumpy::prelude::bones_schema::Primitive

impl Debug for SchemaKind

impl Debug for SchemaRefAccess<'_>

impl Debug for SchemaRefMutAccess<'_>

impl Debug for jumpy::prelude::egui::containers::panel::Side

impl Debug for TopBottomSide

impl Debug for ScrollBarVisibility

impl Debug for AboveOrBelow

impl Debug for jumpy::prelude::egui::Align

impl Debug for jumpy::prelude::egui::CursorIcon

impl Debug for jumpy::prelude::egui::Direction

impl Debug for jumpy::prelude::egui::Event

impl Debug for FontFamily

impl Debug for ImageFit

impl Debug for jumpy::prelude::egui::Key

impl Debug for MouseWheelUnit

impl Debug for Order

impl Debug for PointerButton

impl Debug for Shape

impl Debug for TextStyle

impl Debug for TextureFilter

impl Debug for jumpy::prelude::egui::TextureId

impl Debug for jumpy::prelude::egui::TouchPhase

impl Debug for jumpy::prelude::egui::UserAttentionType

impl Debug for WidgetType

impl Debug for jumpy::prelude::egui::epaint::Primitive

impl Debug for jumpy::prelude::egui::load::Bytes

impl Debug for jumpy::prelude::egui::load::LoadError

impl Debug for OperatingSystem

impl Debug for OutputEvent

impl Debug for jumpy::prelude::ButtonState

impl Debug for CameraSize

impl Debug for CollectionAllocErr

impl Debug for jumpy::prelude::Color